Cards

Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.

Setup code

To demonstrate that bslib cards work outside of Shiny (i.e., in R Markdown, static HTML, etc), we’ll make repeated use of statically rendered htmlwidgets like plotly and leaflet. Here’s some code to create those widgets:

library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)

plotly_widget <- plot_ly(x = diamonds$cut) %>%
  config(displayModeBar = FALSE) %>%
  layout(margin = list(t = 0, b = 0, l = 0, r = 0))

leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
  leaflet(options = .) %>%
  addTiles()

Shiny usage

Cards work equally well in Shiny. In the examples below, replace plotly_widget with plotlyOutput() and leaflet_widget with leafletOutput() to adapt them for Shiny server-rendered plots/maps.

Hello `card()`

A card() is designed to handle any number of “known” card items (e.g., card_header(), card_body(), etc) as unnamed arguments (i.e., children). As we’ll see shortly, card() also has some useful named arguments (e.g., full_screen, height, etc).

At their core, card() and card items are just an HTML div() with a special Bootstrap class, so you can use Bootstrap’s utility classes to customize things like colors, text, borders, etc.

card(
  card_header(
    class = "bg-dark",
    "A header"
  ),
  card_body(
    markdown("Some text with a [link](https://github.com)")
  )
)

A header

Some text with a link

Implicit `card_body()`

If you find yourself using card_body() without changing any of its defaults, consider dropping it altogether since any direct children of card() that aren’t “known” card() items, are wrapped together into an implicit card_body() call.¹ For example, the code to the right generates HTML that is identical to the previous example:

card(
  card_header(
    class = "bg-dark",
    "A header"
  ),
  markdown("Some text with a [link](https://github.com).")
)

A header

Some text with a link.

Restricting growth

By default, a card()’s size grows to accommodate the size of it’s contents. Thus, if a card_body() contains a large amount of text, tables, etc., you may want to specify a height or max_height. That said, when laying out multiple cards, it’s likely best not to specify height on the card(), and instead, let the layout determine the height layout_column_wrap().

Although scrolling is convenient for reducing the amount of space required to park lots of content, it can also be a nuisance to the user. To help reduce the need for scrolling, consider pairing scrolling with full_screen = TRUE (which adds an icon to expand the card’s size to the browser window). Notice how, when the card is expanded to full-screen, max_height/height won’t effect the full-screen size of the card.

card(
  max_height = 250,
  full_screen = TRUE,
  card_header(
    "A long, scrolling, description"
  ),
  lorem::ipsum(paragraphs = 3, sentences = 5)
)

A long, scrolling, description

Consectetur egestas potenti dapibus habitant per; sociosqu, in, id, nullam suscipit. Porttitor eu posuere sed primis fringilla magna himenaeos iaculis, sem nunc auctor lectus. Venenatis non feugiat inceptos, habitant purus faucibus ligula himenaeos taciti quisque class. Pellentesque tortor euismod nostra, est pulvinar nec habitasse vehicula eu. Nec semper nam?

Consectetur laoreet litora dictumst nisi sollicitudin est rutrum hac nullam neque magna. Ultrices orci etiam sem nascetur dignissim, rhoncus interdum risus ad pharetra feugiat. Dignissim natoque netus nec, lectus purus commodo cras id sociis ridiculus! Placerat quam sapien habitant posuere dis aliquam litora porttitor porta nisl. Eros placerat porttitor?

Amet tincidunt nibh porta dignissim tortor vehicula ornare! Hendrerit curae a pellentesque sollicitudin, netus nullam varius, turpis quam condimentum cras tempus et. Curabitur lectus nascetur vulputate odio semper: habitasse magnis conubia, magna platea himenaeos purus. Aliquam commodo feugiat velit ultricies id nisi cum fermentum, hendrerit nullam. Mi integer habitant nam duis, morbi inceptos tortor tellus tincidunt, bibendum erat eu ac nascetur.

Filling outputs

A card()’s default behavior is optimized for facilitating filling layouts. More specifically, if a fill item (e.g., plotly_widget), appears as a direct child of a card_body(), it resizes to fit the card()s specified height. This means, by specifying height = 250 we’ve effectively shrunk the plot’s height from its default of 400 down to about 200 pixels. And, when expanded to full_screen, the plot grows to match the card()’s new size.

card(
  height = 250,
  full_screen = TRUE,
  card_header("A filling plot"),
  card_body(plotly_widget)
)

A filling plot

Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny output bindings (e.g, plotOutput(), imageOutput(), etc) are fill items by default, so this behavior “just works” in those scenarios. And, in some of these situations, it’s helpful to remove card_body()’s padding, which can be done via spacing & alignment utility classes.

card(
  height = 275,
  full_screen = TRUE,
  card_header("A filling map"),
  card_body(
    class = "p-0",
    leaflet_widget
  ),
  card_footer(
    class = "fs-6",
    "Copyright 2023 RStudio, PBC"
  )
)

A filling map

Fill item(s) aren’t limited in how much they grow and shrink, which can be problematic when a card becomes very small. To work around this, consider adding a min_height on the card_body() container. For example, try using the handle on the lower-right portion of this card example to make the card taller/smaller.

This interactive example is a bit contrived in that we’re using CSS resize to demonstrate how to make plots that don’t shrink beyond a certain point, but this concept becomes quite useful when implementing page-level filling layouts (i.e., page_fillable()) with multiple cards.

card(
  height = 300,
  style = "resize:vertical;",
  card_header("Plots that grow but don't shrink"),
  card_body(
    min_height = 250,
    plotly_widget,
    plotly_widget
  )
)

Plots that grow but don't shrink

Troubleshooting fill

As you’ll learn more about in filling layouts, a fill item loses its ability to fill when wrapped in additional UI element that isn’t a fillable container. To fix the situation, use as_fill_carrier() to allow the additional element to carry the potential to fill from the card_body() down to the fill item.

Multiple `card_body()`

A card() can have multiple card_body()s, which is especially useful for:

Combining both resizable and non-resizable contents (i.e., fill items and non-fill).
Allowing each card_body() to have their own styling (via inline styles and/or utility classes) and resizing limits (e.g., min_height).

For example, when pairing filling output with scrolling content, you may want min_height on the filling output since the scrolling content will force it to shrink:

card(
  height = 375,
  full_screen = TRUE,
  card_header(
    "Filling plot, scrolling description"
  ),
  card_body(
    min_height = 200,
    plotly_widget
  ),
  card_body(
    class = "lead container",
    lorem::ipsum(paragraphs = 10, sentences = 5)
  )
)

Filling plot, scrolling description

Sit cubilia tempor risus, torquent vehicula, magna egestas augue urna purus hac morbi vivamus. Dis felis bibendum mauris, lacinia vestibulum aliquet ullamcorper tincidunt interdum. Enim inceptos posuere suscipit habitant urna duis leo neque tristique habitasse condimentum. Bibendum at, et conubia primis cubilia, varius vehicula commodo accumsan. Gravida volutpat tellus senectus hac integer.

Elit inceptos massa tristique lacinia pulvinar faucibus tempus, tortor nostra cras. Aliquam arcu fringilla tempor praesent class duis. Pulvinar mollis nulla, sagittis commodo ad! Eros imperdiet porta parturient massa, suspendisse lectus imperdiet vivamus? Maecenas facilisi sem viverra phasellus; quam, tempus bibendum mollis sagittis semper class facilisis dui metus ridiculus purus.

Consectetur morbi malesuada – interdum cum ut curae, facilisi ac habitasse quis hac. Sapien praesent mollis platea at, porttitor mus sem etiam feugiat! Hendrerit iaculis suscipit porta odio odio metus. Sagittis interdum leo mauris integer risus dignissim pellentesque himenaeos interdum mauris metus? Quisque tristique platea facilisi euismod curae nostra cursus?

Consectetur lacus litora porta luctus facilisi, cum dignissim accumsan! Eget odio velit vitae vel duis nisi egestas duis praesent at nunc quam. Laoreet malesuada integer dapibus quam quam. Elementum torquent suscipit ut tellus, proin rhoncus gravida maecenas facilisi feugiat. Dis nullam; elementum dui fermentum, in at.

Consectetur tempor gravida euismod, pharetra, congue arcu ante! Congue proin ultrices montes metus mi nullam suscipit lectus pulvinar. Turpis augue suscipit, fermentum tortor lectus? Ridiculus vivamus consequat curabitur, taciti dui torquent senectus imperdiet. Aliquet in iaculis vitae venenatis conubia id velit dictumst semper leo ligula nostra tempor netus duis luctus; congue massa nullam sociis senectus.

Consectetur commodo sociis, litora etiam, montes fames purus sagittis natoque per tellus! Proin magna eu justo vivamus, est tellus integer dui parturient? Dictumst at conubia nibh praesent condimentum, facilisi: platea egestas integer – sociosqu proin aptent erat taciti! Ac ullamcorper dui quis hac quam! Dapibus netus luctus fames.

Lorem proin odio cum parturient sapien velit commodo, consequat aliquet ad. Libero molestie vulputate erat et accumsan, mi ultrices aenean mauris velit pharetra conubia. Cras habitasse tempus morbi scelerisque mus at eget eros vulputate morbi. Neque aptent sollicitudin mollis ornare, quisque, quam convallis, egestas iaculis integer aptent rhoncus risus! Convallis fames bibendum facilisi aptent aptent.

Consectetur aliquet feugiat venenatis; tellus eu fames, pellentesque primis morbi class magna. Varius ultricies gravida cursus odio: turpis primis tristique neque fringilla mus. Quis neque tellus, tempus lacus – habitant ligula montes lectus. Justo class egestas lacus diam quis vestibulum nam himenaeos! Fringilla felis leo massa himenaeos volutpat ac mi.

Lorem tristique netus velit non vivamus dui sed facilisis. Ultrices parturient conubia sagittis integer aenean habitasse torquent inceptos? Tellus rutrum tempor scelerisque: et sem class tempus scelerisque nisi. Sodales augue volutpat vivamus euismod eget, egestas blandit odio. Primis elementum: libero luctus etiam in, at dictum mattis integer sociosqu, mauris semper torquent erat cras vel.

Dolor ridiculus, facilisi maecenas dis ligula eget eros accumsan faucibus. Lobortis hendrerit per vehicula ultricies vestibulum fringilla lectus cum tincidunt porta lacus. Est felis elementum parturient pretium ante et posuere eu? Cum scelerisque porta sodales duis donec scelerisque fusce maecenas eros! Rhoncus enim facilisi metus imperdiet per vestibulum lobortis per hendrerit curae vulputate.

Also, when the content has a fixed size, and should not be allowed to scroll, set fill = FALSE:

card(
  height = 350,
  full_screen = TRUE,
  card_header(
    "Filling plot, short description"
  ),
  plotly_widget,
  card_body(
    fill = FALSE, gap = 0,
    card_title("A subtitle"),
    p(class = "text-muted", "And a caption")
  )
)

Filling plot, short description

A subtitle

And a caption

Multiple columns

As you’ll learn in column-based layouts, layout_column_wrap() is great for multi-column layouts that are responsive and accommodate for filling output. Here we have an equal-width 2-column layout using width = 1/2, but it’s also possible to have varying column widths.

card(
  height = 350,
  full_screen = TRUE,
  card_header("A multi-column filling layout"),
  card_body(
    min_height = 200,
    layout_column_wrap(
      width = 1/2,
      plotOutput("p1"),
      plotOutput("p2")
    )
  ),
  lorem::ipsum(paragraphs = 3, sentences = 5)
)

A multi-column filling layout

Lorem viverra fusce erat convallis feugiat – nibh cubilia arcu quam! Senectus massa pretium eros felis facilisi nunc arcu. Aliquet rhoncus eget ornare platea eros facilisis sollicitudin fringilla. Parturient venenatis hac per aptent nascetur augue integer – mattis; est cursus cras sagittis. Fermentum nulla cursus lacus nullam porttitor pharetra habitasse hac – nisl; in tincidunt maecenas praesent?

Sit dapibus montes ornare est magnis curae praesent nibh luctus urna. Dignissim purus aenean ac, parturient eu aptent sociosqu tristique. Eu quam, turpis tempor suspendisse neque eget varius molestie taciti fermentum porta magnis. Habitasse nec condimentum laoreet taciti semper aliquet est. Hendrerit ac aliquet morbi fermentum vel est primis rutrum vulputate eleifend torquent conubia sed?

Adipiscing donec curabitur commodo id pellentesque, aptent enim urna nec suscipit! Cras convallis lacinia litora nam senectus lectus, gravida ligula cubilia. Urna dignissim sociis vivamus augue suscipit lobortis vehicula rutrum fringilla eleifend nec? Id quisque lectus at et, cum bibendum nibh, mollis ultricies pellentesque velit? Fermentum dictumst leo – taciti et eros velit, vulputate venenatis.

Multiple cards

layout_column_wrap() is especially nice for laying out multiple cards since each card in a particular row will have the same height (by default). Learn more in column-based layouts.

layout_column_wrap(
  width = 1/2,
  height = 300,
  card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
  card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)

A filling plot

A filling map

Multiple tabs

navset_card_tab() and navset_card_pill() make it possible to create cards with multiple tabs or pills. These functions have the same full_screen capabilities as normal card()s as well some other options like title (since there is no natural place for a card_header() to be used). Note that, each nav_panel() object is similar to a card(). That is, if the direct children aren’t already card items (e.g., card_title()), they get implicitly wrapped in a card_body().

library(leaflet)
navset_card_tab(
  height = 450,
  full_screen = TRUE,
  title = "HTML Widgets",
  nav_panel(
    "Plotly",
    card_title("A plotly plot"),
    plotly_widget
  ),
  nav_panel(
    "Leaflet",
    card_title("A leaflet plot"),
    leaflet_widget
  ),
  nav_panel(
    shiny::icon("circle-info"),
    markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
  )
)

HTML Widgets

Plotly
Leaflet

A plotly plot

A leaflet plot

Learn more about htmlwidgets

Sidebars

As you’ll learn more about in sidebar layouts, layout_sidebar() just works when placed inside in a card(). In this case, if you want fill items (e.g., plotly_widget) to still fill the card like we’ve seen before, you’ll need to set fillable = TRUE in layout_sidebar().

card(
  height = 300,
  full_screen = TRUE,
  card_header("A sidebar layout inside a card"),
  layout_sidebar(
    fillable = TRUE,
    sidebar = sidebar(
      actionButton("btn", "A button")
    ),
    plotly_widget
  )
)

A sidebar layout inside a card

Static images

card_image() makes it easy to embed static (i.e., pre-generated) images into a card. Provide a URL to href to make it clickable. In the case of multiple card_image()s, consider laying them out in multiple cards with layout_column_wrap() to produce a grid of clickable thumbnails.

card(
  height = 300,
  full_screen = TRUE,
  card_image(
    file = "shiny-hex.svg",
    href = "https://github.com/rstudio/shiny"
  ),
  card_body(
    fill = FALSE,
    card_title("Shiny for R"),
    p(
      class = "fw-light text-muted",
      "Brought to you by RStudio."
    )
  )
)

Shiny for R

Brought to you by RStudio.

Flexbox

Both card() and card_body() default to fillable = TRUE (that is, they are CSS flexbox containers), which works wonders for facilitating filling outputs, but it also leads to surprising behavior with inline tags (e.g., actionButton(), span(), strings, etc). Specifically, each inline tag is placed on a new line, but in a “normal” layout flow (fillable = FALSE), inline tags render inline.

card(
  card_body(
    fillable = TRUE,
    "Here's some", tags$i("inline"), "text",
    actionButton("btn1", "A button")
  ),
  card_body(
    fillable = FALSE,
    "Here's some", tags$i("inline"), "text",
    actionButton("btn2", "A button")
  )
)

Here's some inline text

That said, sometimes working in a flexbox layout is quite useful, even when working with inline tags. Here we leverage flexbox’s gap property to control the spacing between a plot, a (full-width) button, and paragraph. Note that, by using markdown() for the paragraph, it wraps the results in a <p> tag, which means the contents of the paragraph are not longer subject to flexbox layout. If we wanted, we could do something similar to render the actionButton() inline by wrapping it in a div().

card(
  height = 325, full_screen = TRUE,
  card_header("A plot with an action links"),
  card_body(
    class = "gap-2 container",
    plotly_widget,
    actionButton(
      "go_btn", "Action button",
      class = "btn-primary rounded-0"
    ),
    markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
  )
)

A plot with an action links

Here's a simple hyperlink.

In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.

card(
  height = 300, full_screen = TRUE,
  card_header(
    class = "d-flex justify-content-between",
    "Centered plot",
    checkboxInput("check", " Check me", TRUE)
  ),
  card_body(
    class = "align-items-center",
    plotOutput("id", width = "75%")
  )
)

Centered plot

Check me

Shiny

Since this article is statically rendered, the examples here use statically rendered content/widgets, but the same card() functionality works for dynamically rendered content via Shiny (e.g., plotOutput(), plotlyOutput(), etc).

An additional benefit that comes with using shiny is the ability to use getCurrentOutputInfo() to render new/different content when the output container becomes large enough, which is particularly useful with card(full_screen = T, ...). For example, you may want additional captions/labels when a plot is large, additional controls on a table, etc (see the value boxes article for a clever use of this).

# UI logic
ui <- page_fluid(
  card(
    max_height = 200,
    full_screen = TRUE,
    card_header("A dynamically rendered plot"),
    plotOutput("plot_id")
  )
)

# Server logic
server <- function(input, output, session) {
  output$plot_id <- renderPlot({
    info <- getCurrentOutputInfo()
    if (info$height() > 600) {
      # code for "large" plot
    } else {
      # code for "small" plot
    }
  })
}

shinyApp(ui, server)

Appendix

The following CSS is used to give plotOutput() a background color; it’s necessary here because this documentation page is not actually hooked up to a Shiny app, so we can’t show a real plot.

.shiny-plot-output {
  background-color: #216B7288;
  height: 400px;
  width: 100%;
}